/* libwatopt++ - Optimization Toolkit
 *
 * Copyright (c) 2007 Christopher Alexander Watford
 * <christopher.watford@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * $Id: ga_instrument.hpp 2 2007-05-06 18:01:15Z christopher.watford $
 */

#if _MSC_VER > 1000
#pragma once
#endif /* _MSC_VER > 1000 */

#ifndef _GA_INSTRUMENT_HPP_
#define _GA_INSTRUMENT_HPP_

#include <string>
#include <iostream>
#include <fstream>

#include <opt.hpp>
#include <ga.hpp>

namespace watopt
{
   class CSV_GAInstrumentor : public IGeneticAlgorithmInstrumentation
   {
   public:
      CSV_GAInstrumentor(const char* filename, size_t genStep, bool stdOut);
      CSV_GAInstrumentor(const CSV_GAInstrumentor& other);

      CSV_GAInstrumentor& operator=(const CSV_GAInstrumentor& other);

      void SetDelimeter(const std::string& delim) { _m_Delim = delim; }
      std::string GetDelimeter(void) const { return _m_Delim; }

      void Start(const std::vector<IFitnessImplementation*>& pop,
         double minFit, double maxFit, double avgFit, double variance);
      void ParentsSelected(const IFitnessImplementation* parent1,
         const IFitnessImplementation* parent2);
      void PopulaceConverged(size_t generation,
         const std::vector<IFitnessImplementation*>& pop,
         double fitness);
      void EndGeneration(size_t generation,
         const std::vector<IFitnessImplementation*>& pop,
         double minFit, double maxFit, double avgFit, double variance);
      void Stop(const std::vector<IFitnessImplementation*>& pop,
         double minFit, double maxFit, double avgFit, double variance);

   private:
      std::ofstream  _m_os;
      std::string    _m_Filename;
      std::string    _m_Delim;
      size_t         _m_Interval;
      bool           _m_Stdout;
   };
}

#endif /* !defined(_GA_INSTRUMENT_HPP_) */
